home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 4 / United Public Domain Gold 4.iso / tbag / tb048.dms / tb048.adf / Docs / mines.docs < prev    next >
Text File  |  1990-09-23  |  10KB  |  343 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.             _____________________________________
  9.          __M_______I_______N_______E_______S__
  10.  
  11.                 © Copyright 1990
  12.                        by
  13.                 Gary W. Milliorn
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.     Mines is a program where you try to traverse a minefield.  In  the
  23. field are some number of mines, but you won't know where they are located.
  24. Instead, when you move to an area that does not contain a mine, Mines will
  25. reveal the quantity of mines immediately surrounding it, from 0 to 8.
  26.  
  27.     By applying logic, and occasionally a little luck, you can  safely
  28. determine where the mines are located and can avoid stepping on them.
  29.  
  30.     Mines has the following features:
  31.  
  32.         * Automatically adapts to WorkBench colors and font heights.
  33.         * Selectable minefield size, up to 30w x 20h.
  34.         * Selectable number of mines.
  35.         * 3D-effect tiles.
  36.         * CLI and WorkBench parameters.
  37.         * Automatically saves setups and games in-progress.
  38.         * Sound effects.
  39.         * Cumulative scores.
  40.         * The usual lot of suspects, er, programmable options.
  41.  
  42.  
  43. ---------
  44. COPYRIGHT
  45. ---------
  46.  
  47.     This program is © Copyright 1990, by Gary W. Milliorn.  It may be
  48. freely redistributed as long as the copyright notice remains intact,  and
  49. documentation  remains  together  with  the program.  This program is NOT
  50. public domain; no fee may be charged  for  it  other  than  a  reasonable
  51. duplication fee.
  52.  
  53.     There is no charge for this program, unless you feel it is  worth
  54. anything.  Mostly, just drop me a note on bix ("gmill") or in the mail if
  55. you like it or otherwise.
  56.  
  57.  
  58. --------------
  59. STARTING MINES
  60. --------------
  61.  
  62.     Mines may be started from the CLI or from WorkBench.   There  are
  63. options available in both modes; these are discussed later.
  64.  
  65.     Once  started,  Mines   reads   in   settings   from   the   file 
  66. "S:.MineScores",  if possible.  After that, it processes CLI or WorkBench
  67. arguments or tooltypes.  It then opens the window of appropriate size  on
  68. the  WorkBench  screen  (it may decide to reduce the size if the system's
  69. font is too large to handle).
  70.  
  71.     Once Mines is  started,  you  can  begin  to  play  by  selecting
  72. "New Game"  from  the menu.  Mines will draw in the minefield as a series
  73. of cross-hatched, raised shadow squares, which I call "cells".   It  then
  74. places the Start cell int the upper left-hand corner, and the End cell in
  75. the lower right-hand corner.
  76.  
  77.     To make a move, use the mouse to click on a cell.  You  can  only
  78. click  on  cells  next to the Start cell, or next to other cells you have
  79. seen.  In other words, you have to "walk" across the  mine  field.   When
  80. you  click  on  a  cell  you  have not seen before, Mines will reveal the
  81. contents, which could be any of:
  82.  
  83.     a Mine -         Boom!  you lose.
  84.     an empty square    -    no mines at all are nearby, it is safe to move
  85.                 in any direction.
  86.     a numbered square -    there are 1 to 8 mines around this cell.
  87.  
  88. Examples:
  89.  
  90.     [1][1][1]
  91.     [1][*][1]    - the center cell was a mine, you just lost!
  92.     [1][1][1]
  93.  
  94.     [ ][ ][ ]
  95.     [ ][ ][ ]    - the center cell has no mines nearby, so it is blank.
  96.     [ ][ ][ ]
  97.  
  98.     [*][ ][ ]
  99.     [ ][1][ ]    - the center cell has one mine nearby, so a '1' is
  100.     [ ][ ][ ]      drawn in the center.
  101.  
  102.     [*][ ][*]
  103.     [ ][5][*]    - the center cell has five mines nearby, so a '5' is
  104.     [*][*][ ]      drawn in the center.
  105.  
  106.     [*][*][*]
  107.     [*][8][*]    - the center cell has eight mines nearby, so an '8' is
  108.     [*][*][*]      drawn in the center.  Bonus question: why won't you
  109.               ever see this during a game?
  110.  
  111.  
  112. ---------------------
  113. MARKING THE MINEFIELD
  114. ---------------------
  115.  
  116.     It is sometimes necessary to perform trial moves  to  figure  out
  117. where the mines are located.  In other words, "if there's a mine here and
  118. this cell is ok, then there would have to  be  another  mine  over  here,
  119. which  is  impossible,  so the mine must be here ... <CLICK>  Great!  Ok,
  120. next I'll...".
  121.  
  122.     Situations like these sometimes occur while playing, and to  help
  123. you,  Mines allows you to place "markers" on any cell, even ones that you
  124. couldn't ordinarily step on.
  125.  
  126.     To place a marker, hold down either SHIFT key, and click  on  the
  127. desired cell.  Each time you do this on one cell, Mines will add the next
  128. marker in sequence, as follows:
  129.  
  130.         Unseen Cell
  131.             |
  132.             V
  133.         Mine Mark    -- i.e., you think there's a mine here.
  134.             |
  135.             V
  136.         'ok' Mark    -- i.e., you think there isn't a mine here.
  137.             |
  138.             V
  139.         Unseen Cell
  140.  
  141.     Marked cells differ from ones you have stepped on  in  that  they
  142. retain their raised appearance.
  143.  
  144.     When the game is over, win or  lose,  if  you  have  enabled  the
  145. "Show Results"  option,  Mines  will highlight  any incorrect guesses you
  146. have made.  It is possible to make a bad guess and  still  win --  that's
  147. the nature of the game.
  148.  
  149.  
  150. -------------------
  151. WORKBENCH ARGUMENTS
  152. -------------------
  153.  
  154.     The Mines tool may be started from the WorkBench.  A  minimum  of
  155. 8K  is  recommended  for the stack, and the following tool-type arguments
  156. are supported:
  157.  
  158.     AUTOCOLOR=OFF    -- if "ON", Mines will try to select the colors
  159.     AUTOCOLOR=ON       it needs (white, black, grey, and one of red
  160.                green or blue).  If you have non-default
  161.                colors, Mines will still obtain the colors
  162.                needed to obtain the 3D appearance if some
  163.                approximation to those colors exists.
  164.  
  165.                If the results are truly horrible, disable
  166.                the option and Mines will use some defaults,
  167.                or you can program it yourself with the
  168.                COLOR* arguments.
  169.  
  170.                By default, Mines picks its colors from the
  171.                WorkBench color map.
  172.  
  173.  
  174.     AUTOSAVE=OFF    -- if "ON", Mines will save settings and any
  175.     AUTOSAVE=ON       unfinished games in the file "S:.MineScores"
  176.                when the menu "Quit" is selected, or if the
  177.                window is closed.
  178.  
  179.                If OFF, Mines will never write to your disk.
  180.  
  181.                By default, games and game settings are saved.
  182.  
  183.     COLOR_BLACK=n    -- Set the color index for black to number 'n'.
  184.  
  185.     COLOR_BACKGROUND=n  -- Set the color index for the background to
  186.                       number 'n'.
  187.  
  188.     COLOR_RED=n    -- Set the color index for red (or the highlighting
  189.                color) to number 'n'.
  190.  
  191.     COLOR_WHITE=n    -- Set the color index for white to number 'n'.
  192.  
  193.     SIZE=W'x'H    -- Set the mine field size to W by H, measured in
  194.     SIZE=20x30       terms of cells.  Example: the default size
  195.                string would be "10x10".  The maximum width is
  196.                30 and the maximum height is 20 cells.  The
  197.                minimum width and height is 4 cells.
  198.  
  199.     SOUND=OFF    -- if "ON", Mines will use sound effects as
  200.     SOUND=ON       needed.
  201.  
  202.  
  203. -------------
  204. CLI ARGUMENTS
  205. -------------
  206.  
  207.     Mines may also be started from the CLI.  As before, at  least  8K
  208. of stack is recommended.  The CLI arguments supported are:
  209.  
  210.     Mines [-c0 n] [-cb n] [-cr n] [-cw n] [-dnsv] [-wW'x'H]
  211.  
  212.     -c0 n    -- Sets the color index for the background to number 'n'.
  213.  
  214.     -cb n    -- Sets the color index for black to number 'n'.
  215.  
  216.     -cr n    -- Sets the color index for red (or the highlighting
  217.            color) to number 'n'.
  218.  
  219.     -cw n    -- Sets the color index for white to number 'n'.
  220.  
  221.     -d    -- disables the automatic color code.  Set this if you
  222.            have trouble or if you use any of the '-c*' options.
  223.            Enabled on startup.
  224.  
  225.     -n    -- disables writing scores and saved games to the disk.
  226.            Enabled on startup.
  227.  
  228.     -s    -- disables sound effects.  Enabled on startup.
  229.  
  230.     -wW'x'H -- Sets the mine field size to W by H, measured in
  231.            terms of cells.  For example, the default size string
  232.            would be "10x10".
  233.  
  234.  
  235. -----
  236. MENUS
  237. -----
  238.  
  239. Mines
  240.     About         -- brings up my logo, and then a standard information
  241.             box about the program.  The logo goes away auto-
  242.             matically after a few seconds, or you can click on
  243.             it.
  244.  
  245.     Help         -- brings up an "animated" help window which should,
  246.                hopefully, explain how to play the game.  It's much
  247.             easier to show how to play than to explain it.
  248.  
  249.     New Game     -- starts a new game, using the current size and
  250.                 quantity of mines.  When a game begins, the
  251.                 number of mines cannot be changed, and the
  252.                 window cannot be resized.
  253.  
  254.     Resign Game  -- quit the current game.  Clears the board and
  255.             allows you to change the size or mine count,
  256.             if desired.
  257.  
  258.     Scores         -- shows your current count of wins, losses, and
  259.             performance in the message area.
  260.  
  261.     Quit         -- quits Mines.  If a game is in progress, and saved
  262.                 games are allowed, it is written to the save file.
  263.                 Other parameters, such as Sound, Size, number of
  264.                 mines, etc. are also saved.
  265.  
  266. Options
  267.     Auto-Advance -- if checked, when you step on a mine that has no
  268.             neighbors, Mines automatically reveals the unseen
  269.             cells immediately nearby (since it is obviously
  270.             safe to move there).
  271.  
  272.             If the new cells revealed are also safe, Mines
  273.             advances across the board, showing safe mines
  274.             until all are seen.
  275.  
  276.             This option speeds up the game by eliminating
  277.             some of the drudgery, but if you're a learner,
  278.             it may appear confusing -- consider disabling
  279.             it initially.
  280.  
  281.  
  282.     Show Results -- if checked, when you finish a game, win or lose,
  283.             Mines will reveal the contents of the mine field.
  284.             If you marked a cell as having a mine or as being
  285.             'ok', and this was not true, Mines X's the cell
  286.             and counts the number of wrong guesses.
  287.  
  288.             Wrong guesses do not affect your scores.
  289.  
  290.     Sound         -- if checked, Mines will use sound effects as
  291.             appropriate.
  292.  
  293.     Save Setup   -- if checked, Mines will save the game setup and any
  294.             unfinished game when the game is quit or closed.
  295.  
  296.     Mine Count...--    when this item is selected, Mines brings up a
  297.             window which allows you to enter the number of
  298.             mines you want in the mine field.
  299.  
  300.             You may enter any number from 0 to 80% of the
  301.             total number of cells in the mine field.
  302.  
  303. -------------
  304. OTHER PROGRAMS
  305. --------------
  306.  
  307. Currently available on a BBS near you:
  308.     ImageLab -- an IFF image processing program.
  309.     WellTrix -- classic Tetris (tm) -style program played in a well.
  310.  
  311. Coming soon:
  312.     Assistant   -- programmer's assistant.
  313.     Mines 3.0   -- with an Arexx port to play automatically.
  314.     WellTrix II -- ???
  315.  
  316.  
  317. _______________________________________________________________________________
  318.  
  319.  
  320.                 T H E  E N D
  321.  
  322.             Written, Produced and Directed
  323.                      by
  324.                       Gary W. Milliorn
  325.  
  326.  
  327.                  _____________________________________
  328.               __M_______I_______N_______E_______S__
  329.  
  330.                    © Copyright 1990, Valan Inc.
  331.  
  332.                    \                          /
  333.                     \                        /    
  334.                      \         |            /     
  335.                       \  / /\  |  /\   /\  /      
  336.                        \/ /  \ | /  \ /  \/       
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.